<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>eRPC API Reference: RPMsgMessageBufferFactory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">eRPC API Reference
   &#160;<span id="projectnumber">Rev. 1.5.0</span>
   </div>
   <div id="projectbrief">NXP Semiconductors</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>API&#160;Reference</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_r_p_msg_message_buffer_factory.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_r_p_msg_message_buffer_factory-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">RPMsgMessageBufferFactory Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>RPMsg zero copy message buffer factory.  
 <a href="class_r_p_msg_message_buffer_factory.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for RPMsgMessageBufferFactory:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_r_p_msg_message_buffer_factory__inherit__graph.svg" width="206" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for RPMsgMessageBufferFactory:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="class_r_p_msg_message_buffer_factory__coll__graph.svg" width="206" height="112"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a54ebe83974bdd2d17956e3003f6a7fca"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_p_msg_message_buffer_factory.html#a54ebe83974bdd2d17956e3003f6a7fca">RPMsgMessageBufferFactory</a> (struct rpmsg_lite_instance *rpmsg)</td></tr>
<tr class="memdesc:a54ebe83974bdd2d17956e3003f6a7fca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a54ebe83974bdd2d17956e3003f6a7fca">More...</a><br /></td></tr>
<tr class="separator:a54ebe83974bdd2d17956e3003f6a7fca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c43c797bb1bb8de89e7668464132bf4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6c43c797bb1bb8de89e7668464132bf4"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_p_msg_message_buffer_factory.html#a6c43c797bb1bb8de89e7668464132bf4">~RPMsgMessageBufferFactory</a> ()</td></tr>
<tr class="memdesc:a6c43c797bb1bb8de89e7668464132bf4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a6c43c797bb1bb8de89e7668464132bf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc9449265c16be49a2cf88faff09d984"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_p_msg_message_buffer_factory.html#adc9449265c16be49a2cf88faff09d984">create</a> ()</td></tr>
<tr class="memdesc:adc9449265c16be49a2cf88faff09d984"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function creates new message buffer.  <a href="#adc9449265c16be49a2cf88faff09d984">More...</a><br /></td></tr>
<tr class="separator:adc9449265c16be49a2cf88faff09d984"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d7b928ad25e2ef8e0fc3a227d13e439"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_p_msg_message_buffer_factory.html#a7d7b928ad25e2ef8e0fc3a227d13e439">dispose</a> (<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *buf)</td></tr>
<tr class="memdesc:a7d7b928ad25e2ef8e0fc3a227d13e439"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function disposes message buffer.  <a href="#a7d7b928ad25e2ef8e0fc3a227d13e439">More...</a><br /></td></tr>
<tr class="separator:a7d7b928ad25e2ef8e0fc3a227d13e439"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af655e8fd7910648899263d7718cb5575"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_p_msg_message_buffer_factory.html#af655e8fd7910648899263d7718cb5575">prepareServerBufferForSend</a> (<a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *message)</td></tr>
<tr class="memdesc:af655e8fd7910648899263d7718cb5575"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is preparing output buffer on server side.  <a href="#af655e8fd7910648899263d7718cb5575">More...</a><br /></td></tr>
<tr class="separator:af655e8fd7910648899263d7718cb5575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab3771b2fc455a454b3443a231ae3f7a"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_p_msg_message_buffer_factory.html#aab3771b2fc455a454b3443a231ae3f7a">createServerBuffer</a> ()</td></tr>
<tr class="memdesc:aab3771b2fc455a454b3443a231ae3f7a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function inform server if it has to create buffer for received message.  <a href="#aab3771b2fc455a454b3443a231ae3f7a">More...</a><br /></td></tr>
<tr class="separator:aab3771b2fc455a454b3443a231ae3f7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classerpc_1_1_message_buffer_factory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classerpc_1_1_message_buffer_factory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classerpc_1_1_message_buffer_factory.html">erpc::MessageBufferFactory</a></td></tr>
<tr class="memitem:a9897093c65b390b0c7f1595384ad9029 inherit pub_methods_classerpc_1_1_message_buffer_factory"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_message_buffer_factory.html#a9897093c65b390b0c7f1595384ad9029">MessageBufferFactory</a> ()</td></tr>
<tr class="memdesc:a9897093c65b390b0c7f1595384ad9029 inherit pub_methods_classerpc_1_1_message_buffer_factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a9897093c65b390b0c7f1595384ad9029">More...</a><br /></td></tr>
<tr class="separator:a9897093c65b390b0c7f1595384ad9029 inherit pub_methods_classerpc_1_1_message_buffer_factory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2b0d9092be2a6e757dcc4bdc8baefd5 inherit pub_methods_classerpc_1_1_message_buffer_factory"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac2b0d9092be2a6e757dcc4bdc8baefd5"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_message_buffer_factory.html#ac2b0d9092be2a6e757dcc4bdc8baefd5">~MessageBufferFactory</a> ()</td></tr>
<tr class="memdesc:ac2b0d9092be2a6e757dcc4bdc8baefd5 inherit pub_methods_classerpc_1_1_message_buffer_factory"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classerpc_1_1_client_manager.html" title="Base client implementation. ">ClientManager</a> destructor. <br /></td></tr>
<tr class="separator:ac2b0d9092be2a6e757dcc4bdc8baefd5 inherit pub_methods_classerpc_1_1_message_buffer_factory"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6c5a8426772d5f53ffb09a4687365382"><td class="memItemLeft" align="right" valign="top">struct rpmsg_lite_instance *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_r_p_msg_message_buffer_factory.html#a6c5a8426772d5f53ffb09a4687365382">m_rpmsg</a></td></tr>
<tr class="separator:a6c5a8426772d5f53ffb09a4687365382"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>RPMsg zero copy message buffer factory. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a54ebe83974bdd2d17956e3003f6a7fca"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">RPMsgMessageBufferFactory::RPMsgMessageBufferFactory </td>
          <td>(</td>
          <td class="paramtype">struct rpmsg_lite_instance *&#160;</td>
          <td class="paramname"><em>rpmsg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">rpmsg</td><td>Pointer to instance of RPMSG lite. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="adc9449265c16be49a2cf88faff09d984"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> RPMsgMessageBufferFactory::create </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function creates new message buffer. </p>
<dl class="section return"><dt>Returns</dt><dd>MessageBuffer New created MessageBuffer. </dd></dl>

<p>Implements <a class="el" href="classerpc_1_1_message_buffer_factory.html#a988ac3778b4164dc497429128078447b">erpc::MessageBufferFactory</a>.</p>

</div>
</div>
<a class="anchor" id="a7d7b928ad25e2ef8e0fc3a227d13e439"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void RPMsgMessageBufferFactory::dispose </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *&#160;</td>
          <td class="paramname"><em>buf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function disposes message buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">buf</td><td>MessageBuffer to dispose. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classerpc_1_1_message_buffer_factory.html#a089b5bf3041323a3387c52c86fd61971">erpc::MessageBufferFactory</a>.</p>

</div>
</div>
<a class="anchor" id="af655e8fd7910648899263d7718cb5575"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__infra.html#ga5f8872e58f09a16d192bf664f9898651">erpc_status_t</a> RPMsgMessageBufferFactory::prepareServerBufferForSend </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classerpc_1_1_message_buffer.html">MessageBuffer</a> *&#160;</td>
          <td class="paramname"><em>message</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function is preparing output buffer on server side. </p>
<p>This function do decision if this function want reuse buffer, or use new buffer. In case of using new buffer function has to free given buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">message</td><td>MessageBuffer which can be reused. </td></tr>
  </table>
  </dd>
</dl>

<p>Reimplemented from <a class="el" href="classerpc_1_1_message_buffer_factory.html#aab77e9b0501e87a332f4cb3e2835bd54">erpc::MessageBufferFactory</a>.</p>

</div>
</div>
<a class="anchor" id="aab3771b2fc455a454b3443a231ae3f7a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool RPMsgMessageBufferFactory::createServerBuffer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function inform server if it has to create buffer for received message. </p>
<dl class="section return"><dt>Returns</dt><dd>Has to return TRUE when server need create buffer for receiving message. </dd></dl>

<p>Reimplemented from <a class="el" href="classerpc_1_1_message_buffer_factory.html#a27ba896a8eb9a1aee6b02894acd724cf">erpc::MessageBufferFactory</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a6c5a8426772d5f53ffb09a4687365382"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">struct rpmsg_lite_instance* RPMsgMessageBufferFactory::m_rpmsg</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Pointer to instance of RPMSG lite. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>erpc_setup_mbf_rpmsg.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul class="foot">
    <li class="footer">&copy; 2016 NXP Semiconductors. All rights reserved.
    </li>
  </ul>
</div>
</body>
</html>
